|
|
WSYAPIWS/XMLAPI._Parameters.GetSoapFault
Note that this API is placed in the WYSAPIWS model.
The API is only available in the Java, WinC, WinC/iSeries versions of WebsydianExpress.
| Field | Variable | ...as | Description |
|---|---|---|---|
| FaultString | Output | Output | A description of the error you want to report to the client. |
The API is a memory parameter API.
The SOAP-standard describes a default structure containing a faultcode and a faultstring that must be returned to the client in error situations.
The faultstring is a descriptive text that explains details about the error. This API retrieves the text that a call to the SetSoapFault API has specified.
The faultcode is one of several pre-defined values, but for all errors generated by the service handler, the code must be Server - so this field is not part of the API.
As this API is called automatically by the SoapServiceProcessor function in error situations. You should not have to call this function unless you are creating your own specialized service processor.
Online documentation - WebsydianExpress v3.5